或許我們都曾經遇過這樣的經驗:
在新增一張 Item 時,只是打個標題,然後過個三天、一週、數月,回頭要在檢視時,卻已經忘記這張代表的是什麼,沒有更多的關鍵字協助我們回想,只能耗費更多的時間去回憶與詢問。
或是:
某人發現 Bug,請他回報,卻只是在標題上寫了一個簡單的敘述,完全不知道在什麼環境、版本出現的,要怎麼重現也不知道,甚至簡單到連在哪裡發生的也無從得知。
通常詢問為什麼只寫這麼一點,對方常會回應說不知道該填寫什麼?
有什麼辦法建立一個樣板讓對方填寫應該要有的資訊呢?
這時候就可以透過 Issue Template 減少這些對資訊預期不一致的溝通成本了。這樣在建立 Issue 時,都會提供樣板給建立者填寫,讓我們有更一致的標準與資訊量。
可以先思考看看,在現有的工作環境,新增 Issue 有固定的資訊要填寫嗎?如果是 feature 類的待辦事項,會希望建立者寫什麼?如果是 bug 類的待辦事項,又會希望回報者填什麼?
以 Bug 為例,可以遵循下方步驟去設定樣板: